Grand Slam 3

home *** CD-ROM | disk | FTP | other *** search

/ Grand Slam 3 / Grand Slam 3.iso / 002 / ieditv14.arj / ICEEDIT.DOC < prev next >

Wrap

Text File | 1995-04-29 | 50KB | 1,084 lines

───────────────────────────────────────────────────────────────────────────── ▄█▄ ▄███████▄ ▄█████████▄ ▄█████████▄ ▄████████▄ ▄█▄ ▄██████████▄ █████ ████▀ ▀███ ████ ▀▀▀ ████ ▀▀▀ ████ ▀███ █████ ▀▀▀▀████▀▀▀▀ █████ ████ ████▄▄▄▄▄ ████▄▄▄▄▄ ████ ███ █████ ████ █████ ████ ████▀▀▀▀▀ ████▀▀▀▀▀ ████ ███ █████ ████ █████ ████▄ ▄███ ████ ▄▄▄ ████ ▄▄▄ ████▄▄▄███▀ █████ ████ ▀█▀ ▀███████▀ ▀█████████▀ ▀█████████▀ ▀███████▀ ▀█▀ ▀██▀ ██ ██ ██ █▌ ██ █▌ █▌ ██ ██ ▐▌ ▐▌ ▐▌ ▐ ▐▌ ▐ ▐ ▐▌ ▐▌ ▌ ▌ ▐ ▐ ▐ ▌ ───────────────────────────────────────────────────────────────────────────── IceEdit v1.40 - CopyRight Jeremy Landvoigt, 1994/95 - IceEdit v1.40 ───────────────────────────────────────────────────────────────────────────── ┌───────────────────────────────────────────────────────────────────────────┐ │░░░▒▒▒▓▓▓ Some Unique Features Of IceEdit v1.40 ▓▓▓▒▒▒░░░│ └───────────────────────────────────────────────────────────────────────────┘ ∙ IceEdit has a built in Macro replacement feature that will replace keywords with other words. Eg "RA" -> "RemoteAccess" ∙ IceEdit has a built message censoring feature to weed out inappropriate text. {+} ∙ Character Color Configuration for individual letters such as Uppercase, lowercase, High Bit, numbers, and punctuation. ∙ Random tagline appending feature. {+} ∙ Easy to use control keys. ∙ Color Code insert strings ∙ SysOp defined function key macros ∙ Quoted text re-formatting And MORE! ┌───────────────────────────────────────────────────────────────────────────┐ │░░░▒▒▒▓▓▓ CopyRight Notices & Program Disclaimer ▓▓▓▒▒▒░░░│ └───────────────────────────────────────────────────────────────────────────┘ The utility IceEdit, along with all its support files and documents, are Copyright (C) 1994-95 Jeremy Landvoigt. Distributing a version AFTER it has been registered is prohibited; distribution & execution of the original, unaltered version is permitted, indeed encouraged, as long as all support-files and documentation that accompany the program are included WITHOUT ALTERATION OF ANY SORT. The author can be quickly reached for information through the RA_UTIL international FidoNET Conference. If you wish to trust comments/complaints/suggestions to the Post Office, you can send them to: Jeremy Landvoigt 100 Burling Place Newmarket, Ontario L3Y - 5W4 Canada The following programs mentioned in this documentation are Copyright of their respective authors. They are listed in no particular order: IceEdit - CopyRight Jeremy Landvoigt RemoteAccess - CopyRight Wantree Development & Andrew Milner FKFossil - CopyRight Tim Strike and Forbidden Knights Systems THE USUAL LEGALITIES I (Jeremy Landvoigt) make no warranty of any kind, expressed or implied, including without limitation any warranties of merchantability and/or fitness for a particular purpose. I shall not be held liable for any damages, whether direct, indirect, special or consequential arising from the failure of this program to operate in the manner desired by the user. I shall not be held liable for any damage to data or property which may be caused directly or indirectly by the use of this program. In no event will I be held liable for any damages, including (but not limited to) any lost profits, lost savings, or other incidental or consequential damages arising out of the use -- or the inability to use -- this program, or for any claim by any other party. The only thing that IceEdit is guaranteed to do is to take up space on your hard drive. ┌───────────────────────────────────────────────────────────────────────────┐ │░░░▒▒▒▓▓▓ Credits ▓▓▓▒▒▒░░░│ └───────────────────────────────────────────────────────────────────────────┘ There are a few people who helped with the development of IceEdit that although they weren't involved in the creation or writing of the program, their suggestions, Bug reports, and lengthy ßeta testing have been an enormous asset. I would like to thank in no particular order : David Doyle, David Silver, David Casey, Ian Thomsen, Eric Staufer, and Steve Lanning for all of their help. Couldn't have done it without them! Also, portions of the Fossil Routines used in IceEdit v1.40 are Copyright 1993 By Tim Strike and Forbidden Knights Systems. ┌───────────────────────────────────────────────────────────────────────────┐ │░░░▒▒▒▓▓▓ Registration ▓▓▓▒▒▒░░░│ └───────────────────────────────────────────────────────────────────────────┘ The Development of IceEdit v1.40 took many long hours, and a lot of time and effort not to mention money. This program is not Freeware. If this program satisfies your expectations of a fullscreen editor,if not MORE, then you are expected to register it after an evaluation period of 30 days or sooner. By doing this you can be sure of continued development of the software. Thanks for your support. This Program may be freely distributed but DO NOT under any circumstances change any of the executables or alter any files that come in the original distribution archive. I urge you to register as soon as you can! The more registrations that I have will show the interest of people in the program, and I will release a newer version with many more features. If you register, the Message Censoring & tagline features will become available. All "Unregistered" messages and almost inaudible beeps within the program will also be removed. Please note that the status of features (whether they are available or not to unregistered users) may be changed without further warning in later versions of the software; but this does not mean that they will be changed. If you wish to register, please fill out the registration form : Register.Can - Registration Form For Canadian Users Register.Nl - Registration Form For The Netherlands Register.Eur - Germany & Other European Users Register.Aus - Australia and surrounding Users Register.Usa - For the U.S.A, and for all other Registrations Please at this time send ALL registrations to the address listed in the correct registration form. Thank you for your support. Any Registration forms that have invalid or missing information may be considered void and not be processed, depending on the extent of the errors. Due to recent events, I am changing my policy on personal cheques that are sent in to pay for registration. I will continue to honour them, however as of this release, there will be a 3 week hold placed on the cheque to ENSURE that it does NOT go N.S.F. Although most people are honest about this, lately too many people have sent in N.S.F. cheques, and when contacted about them, show little or no concern about them or the financial difficulties they may have caused. Additionally, a service of $10 will be levied against any N.S.F. cheques. Until both the full payment, and the service charge is recieved in the form of a MONEY ORDER, the registration will not be processed. In conclusion to the above information, to ensure a speedy turnaround time it is recommended you send your registration in the form of a money order (or direct deposit for Canadian residents) If you do choose to send in a personal cheque, it means that you have read and understood these conditions. ┌───────────────────────────────────────────────────────────────────────────┐ │░░░▒▒▒▓▓▓ Archive Contents ▓▓▓▒▒▒░░░│ └───────────────────────────────────────────────────────────────────────────┘ The IceEdit archive should contain the following files : ICEEDIT.EXE - The Main Program EDITCFG.EXE - Use to configure the program 120TO140.EXE - v1.20 to v1.40 configuration converter CENSOR.CFG - Sample Censor keyword file ICEEDIT.DOC - Program Documentation REGISTER.USA - Generic Registration Form REGISTER.NL - The Netherlands Registration Form REGISTER.EUR - Germany/European Registration Form REGISTER.CAN - Canadian Registration Form REGISTER.AUS - Australian Registration Form WHATSNEW.140 - Changes In IceEdit since previous version HISTORY.DOC - Changes In IceEdit since it's creation FILE_ID.DIZ - General Program Description If one or any combination of these files are missing, or files have been ADDED, then you are using a possibly modified or altered copy of IceEdit. It would be advised that you delete this copy, and get a clean copy of IceEdit from one of the BBS's listed at the end of the documentation. Newest Version of IceEdit can be F'REQed from Ice Technologies BBS under the magic name 'ICEEDIT' (Without the quotes) Files IceEdit will create are : ICEEDIT.CFG - The configuration file. ICEEDIT.x - The temporary file which buffer text is stored in. [x] represents current node number. This file also indicates that the current node is in use. MACRO.CFG - The file containing replacement macros. MSGTMP. - Textfile containing message text which is read in by RemoteAccess. Files IceEdit can/will read are : CONFIG.RA - Read when IceEdit is first installed. It will attempt to determine if you are running RA by use of Environment variable, and if it can find the CONFIG.RA, it will read in some information from it. MESSAGES.RA - IceEdit will attempt to read this file if it can locate it by using the RA environment variable. It uses this file to determine whether or not a message area is an echomail/netmail base. If it is, the Color Code feature will be temporarily disabled. DORINFO1.DEF - Drop file containing user information. MSGINF. - File created by RemoteAccess containing message information such as Source User, Target User, message subject, & Message area. MSGTMP. - File created by RemoteAccess containing Quoted text. ┌───────────────────────────────────────────────────────────────────────────┐ │░░░▒▒▒▓▓▓ Program Information ▓▓▓▒▒▒░░░│ └───────────────────────────────────────────────────────────────────────────┘ IceEdit is a fullscreen ANSi message editor that was originally designed for use with RemoteAccess. Although it has only been tested with TG 2.7 & RemoteAccess v2.0x, it should be compatible with any other BBS that uses the QuickBBS style dropfiles that contain the message writing information. These files are MSGTMP & MSGINF. You should check your BBS documentation to see if your software supports this system. IceEdit also calls on the Dorinfo1.Def file to read in necessary information about the user profile. IceEdit has a special feature specifically for RemoteAccess, which is Echobase checking. Do not enable this feature if you are not using RemoteAccess. Why was IceEdit created? .. Well, after I wrote my first major BBS utility, known as IceChat I was really surprised by the response to my chat program and the number of registrations that came in for it. When I first created IceChat, I never expected it to have the impact that it obviously had. This encouraged me to start writing other BBS (specifically RemoteAccess) utilities. A number suggestions came in for utilities such as a UserEditor, a TimeBank, etc, but the most challenging one was to write a Fullscreen message editor, which I thought would be a really great idea. Not only for the challenge, but because right now I feel that there are very few message editors currently available. Of the ones that do exist, one or two of them tend to dominate the market, and they STILL didn't offer all the features that I would like to have in a fullscreen editor. Nevermind ridiculous registration fees. So, thus became the beginnings of IceEdit. ┌───────────────────────────────────────────────────────────────────────────┐ │░░░▒▒▒▓▓▓ Program Configuration - Using EditCfg ▓▓▓▒▒▒░░░│ └───────────────────────────────────────────────────────────────────────────┘ Setting up IceEdit is quite easy. This section of the documentation will attempt to take you step by step on how to use the configuration utility EditCfg.Exe to set up IceEdit. Most of the options are self explanatory. You can use the local testmode feature at any time to test out how your current settings will affect IceEdit.Exe without having to save your settings or exit the configuration program. File ------ █▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀█ ▌ Save & Exit ▐ ▌ Save Without Exit ▐ ▌ Exit Without Save ▐ ▌ Macro Editor ▐ ▌ MacroFile Sorter ▐ ▌ Registration Info ▐ ▌ Program Info ▐ ▌ Compile Taglines ▐ ▌ Compile Dictionary ▐ ▌ Override Editor ▐ ▌ Tagline Manager ▐ ▌ Local Testmode ▐ █▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█ · Save & Exit - This will save your current configuration to the IceEdit.Cfg file and will exit the program. · Save Without Exit - This will save your current configuration to the IceEdit.Cfg file and will allow you to continue modifying your setup. · Exit Without Save - This will abort the save procedure (just in case you somehow really messed up!) and will exit the program. · Macro Editor - This will allow you to define replacement macros that will be used within IceEdit. For example, if you defined a macro such as "RA" -> "RemoteAccess", when the user types "RA" while editing their message, IceEdit will replace it with "RemoteAccess". User Keywords are not case sensitive, so if the user was to type "RA" or "Ra" Or "rA" or "ra", each of these would still be replaced with "RemoteAccess". This function can be useful for correcting commonly misspelled words, replacing shortforms, or "weeding out" inappropriate text (refer to message censoring function aswell). The macrofile used in IceEdit is completely compatible with IceChat's macrofile, so you can interchange the macro files between both pieces of software. · MacroFile Sorter - This will allow you to sort the macrofile in alphabetical order by User Keyword. It will also strip the spaces between macros to eliminate gaps. · Registration Info - This will simply display your current registration status, whether registered or unregistered. · Program Info - This will give you a little bit of information on the current version of IceEdit that you happen to be using. · Compile Taglines - Use this to compile taglines from text format to encrypted datafile format that IceEdit can use. Once compiled, the datafile cannot be edited unless you modify the original textfile and recompile it. Although this might be an inconvenience, it will speed up the random tagline selection process greatly, as it will not be necessary for IceEdit to read the tagline file sequentially. · Compile Dictionary - Use this to compile a textfile with a list of words to a encrypted private dictionary file. This feature is used to add words to the dictionary database that you wouldn't usually find in an average English dictionary, Such as "RemoteAccess", "FrontDoor" etc.. or any other slang terms that might be commonly used. Any words that IceEdit finds in this file will not be treated as mis-spelled. Note, the textfile that contains the words MUST not be the same name as what the compiled file will be called. Eg, if you have 'ICEEDIT.PVT' as your Private dictionary name, make sure you do not name the textfile with this name before compilation. · Override Editor - Use this to define overrides for individual message areas. You can toggle Pipe Codes, Taglines, Censoring, and ANSi individually for every message base that your BBS has. This is for RemoteAccess only. The settings defined will override the default configuration settings. · Tagline Manager - Use this to edit all your compiled tagline files. You can edit, insert, and import new taglines into your compiled files. · Local Testmode - You can use this at anytime during configuration to view how your current configuration will affect IceEdit if you should choose to save. You can execute a local testmode from the dos prompt by running IceEdit like this: ICEEDIT.EXE /L Paths ------- █▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀█ ▌ Censoring File ▐ ▌ Taglines File ▐ ▌ Macro File ▐ ▌ External Chat ▐ ▌ Dictionary File ▐ █▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█ · Censoring File - This is a text file that you can create. If the filename that you provide in this area exists, IceEdit will attempt to read in the file and scan the user's message for any matches of words within this file. If it finds any matches, it will strike out that particular word from the message. For example, if a censor word was "IDIOT", and the user had a sentence such as: "You are such an idiot!" After the scan was complete the word "IDIOT" would be stroked out and the result would be: "You are such an *****!". A sample CENSOR.CFG file is included. The format is very simple; use one word per line. IceEdit is not case sensitive to the particular censoring word that is being compared. Message censoring only takes place AFTER the user opts to save their message. · Taglines File - This file contains taglines that can be appended to the ending of the users message if they opt to save their text. This is a textfile that you can create, although a sample is included called TagLines.Cfg. This file is encrypted, and MUST be compiled from a textfile containing taglines. Use EditCfg to compile. At this time there is not any considerable limitation on the number of taglines that the file may contain. However, the more that there are, the longer it will take EditCfg to read in the textfile and convert it to a structured datafile. IMPORTANT: The file extension of the compiled taglines file MUST be a number. If you are using RemoteAccess with different message GROUPS, it is possible to configure different tagline files for different groups. If you are aren't using groups, or only want one tagline file, it must be named in this format: <FILENAME>.0 It must have the .0 extension to indicate one file. If you create a file called <FILENAME>.2, if the message is being written in a conference which falls in GROUP 2, then this tagline file will be accessed. If IceNote can't find a corresponding tagline file, it will fall back on <FILENAME>.0, so it would be a good idea to have a 'default' tagline file. · Macrofile - This is the name of the macrofile that IceEdit will make use of. It defaults to Macro.Cfg. Refer to FILE>MACRO_EDITOR for more information on macros. · External Chat - This is the full path and filename of your external chat utility. This can be executed from within IceEdit using the ALT-C key. · Dictionary File - This file contains words that are to be added to the dictionary database when IceEdit is executed. This file is encrypted, and MUST be compiled from a textfile containing the words. Use EditCfg to compile this file. At this time there is not any considerable limitation on the number of words that can be in the private dictionary file. However, the more that there are, the longer it will take for EditCfg to compile this file, and for IceEdit to search the file when preforming a Spell Check. Toggles --------- █▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀█ ▌ View Macros YES ▐ ▌ Create Macros NO ▐ ▌ Tagline Prompt YES ▐ ▌ Use Taglines YES ▐ ▌ Display Tagline NO ▐ ▌ Censor Tagline NO ▐ ▌ Imbedded Colors NO ▐ ▌ Check EchoBase NO ▐ ▌ Confirm Abort YES ▐ ▌ Use Quote Color YES ▐ ▌ Filter ANSi NO ▐ ▌ Imbedded Files NO ▐ ▌ Spell Checker YES ▐ ▌ Quote Ratio YES ▐ ▌ Enforce Q Ratio NO ▐ ▌ Upcase Ratio NO ▐ ▌ Enforce C Ratio NO ▐ ▌ Message Censor NO ▐ ▌ Quote Format YES ▐ █▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█ · View Macros YES/NO - Are users permitted to view the list of available macros from within IceEdit by using the CTRL-V key? · Create Macros YES/NO - Are users permitted to add to the list of available macros from within IceEdit by using the CTRL-V key? NOTE: View Macros MUST be enabled for this feature to work. · Tagline Prompt YES/NO - Should the user who is writing the message be prompted as to whether or not a tagline should be appended to the end of their message? If NO, the tagline will be AUTOMATICALLY appended unless the SysOP has not defined the filename of the tagline file. · Use Taglines YES/NO - Should IceEdit access the taglines file in order to append taglines to the end of messages? If NO, the user will not able able to add taglines to the message with IceEdit. · Display Tagline YES/NO - Should IceEdit display to the user whatever tagline it is that has been randomly selected from the tagline database? · Censor Tagline YES/NO - If the user uses inappropriate text in their message and IceEdit is forced to censor the text, should a tagline be appended to the message to inform future message readers of that fact? Eg. "*** This message has been censored by IceEdit v1.40" · Imbedded Colors YES/NO - Should imbedded color codes be permitted? If YES, when the message is saved, all color strings will be replaced by ANSi escape sequences, thus putting colors into the message. Refer below in "Editing Your Message In IceEdit" for more information on Color Strings. · Check EchoBase YES/NO - Should IceEdit attempt to determine whether or not the message area being written to is an Echomail base. If it is, Imbedded color codes will be disabled, as ANSi is not generally accepted in network message areas. This feature is for *RemoteAccess* ONLY. · Confirm Abort YES/NO - Should IceEdit display a message to the user if they choose to abort a message either by '/A', 'CTRL-A' or by use of the help prompt which will ask them if they really want to abort their message? Enabling this feature can help prevent accidental message erasure. · Use Quote Color YES/NO - Should IceEdit use the quote color selected in EditCfg to make quoted text a specific color. If NO, all quoted text will have regular text coloration. · Filter ANSi YES/NO - Should IceEdit disrupt any ANSi that is read into IceEdit whether it be quoted text or manually imported text by the SysOP? If NO, all ANSi codes will be treated normally. · Imbedded Files YES/NO - Should IceEdit process imbedded file names. If YES, IceEdit will read in the external file that is specified and add it to the message text. Eg: If the user put the following string on a line by itself .. %[MAIN.ANS]% If IceEdit can locate the file MAIN.ANS, it will import it into the message text. Any files that you want to have imported MUST be surrounded by the "%[" & "]%" brackets and should be placed on a single line without any other text. You should specify the full path and filename of the file to be imported. Please note, this function will PROPERLY import a file into the message text, but editing before saving is not possible, as all Imbedded files are processed when the user chooses to save. · Spell Checker YES/NO - Should users be permitted to make use of IceEdit's built in spell checking routines? If YES, users can access the spell checker from the status bar. Please note, the spell checker does take a little time, as it must cross reference every word with the dictionary. Also, words smaller than 3 letters will not be checked. · Quote Ratio YES/NO - Should IceEdit check to see if users have exceeded the permitted percentage of quoted text? · Enforce Q Ratio YES/NO - If the Quote Ratio is active, should IceEdit enforce it? If YES, IceEdit will display a message telling the user the current ratio, and that they must cut down. If NO, IceEdit will mention the ratios and display them, and ask the user if they wish to re-edit the message before saving. · Upcase Ratio YES/NO - Should IceEdit check to see if users have exceeded the permitted percentage of Upcase text? · Enforce C Ratio YES/NO - If the Upcase Ratio is active, should IceEdit enforce it? If YES, IceEdit will display a message telling the user the current ratio, and that they must cut down. If NO, IceEdit will mention the ratio and display it, and ask the user if they wish to re-edit the message before saving. · Message Censor YES/NO - Should IceEdit censor the message when the user opts to save? This is a registered only feature. {+} · Quote Format YES/NO - Should IceEdit reformat quoted text? Some editors (such as DOS EDIT) when used in conjunction with BlueWave cause messages to be afflicted with what is commonly known as the "Chainsaw Effect", caused by Hard Returns. IceEdit will now reformat quoted text to remove this annoying problem. Colors -------- █▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀█ ▌ Txt.Punctuation ▐ ▌ Txt.Numbers ▐ ▌ Txt.UpperCase ▐ ▌ Txt.LowerCase ▐ ▌ Txt.High Bit ▐ ▌ Txt.Quoted Text ▐ ▌ Hdr.Hilite ▐ ▌ Hdr.Lolite ▐ ▌ Hdr.Text ▐ ▌ Hdr.Time ▐ ▌ Hdr.Punctuation ▐ ▌ Hdr.Background ▐ ▌ Punctuation ▐ ▌ Numbers ▐ ▌ UpperCase ▐ ▌ LowerCase ▐ ▌ High Bit ▐ ▌ Default Settings ▐ █▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█ · This section on color configuration is self explanatory. Simply select the type of character which you wish to color configure. Another box will appear that will show you the list of available colors. Type in the number of the color you want to use. · TXT refers to all text that can be edited within the EDITING window. (This includes Message Text, and Macro text that can be viewed using CTRL-V) · HDR refers to the screen borders and all text WITHIN the upper header area, as well as text that is in the Quote Window. · All remaining color configuration fields refer to regular strings and prompts that are used within the program. · DEFAULT SETTINGS will restore all the colors to their original installation settings. Fn Macros ----------- █▀▀▀▀▀▀▀▀▀▀▀▀▀█ ▌ F1 Macro ▐ ▌ F2 Macro ▐ ▌ F3 Macro ▐ ▌ F4 Macro ▐ ▌ F5 Macro ▐ ▌ F6 Macro ▐ ▌ F7 Macro ▐ ▌ F8 Macro ▐ ▌ F9 Macro ▐ ▌ F10 Macro ▐ █▄▄▄▄▄▄▄▄▄▄▄▄▄█ · This section is fairly simple. You can define different Function keys (F1,F2..etc) to insert text into the message body while you are editing your message. This is useful for greetings, goodbyes, and signatures that are commonly used. For example, I might configure my Fn Keys like this : F1 - Take Care, F2 - Later.. F3 - Jeremy F4 - SysOP, Ice Technologies F5 - .. Author Of IceChat. etc.. etc.. If I hit one of my Fn Keys while in IceEdit, the appropriate text would be inserted at the current cursor position. Function keys can also be used to IMPORT files, such as multiline sigs. This is done by putting the prefix '@' before the path to the file name. Eg: F1 - @SIG.TXT If the file can't be found, it will simply do nothing. Make sure you specify the full path for the file, or else IceEdit will assume the file should be in the current directory. Other ------- █▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀█ ▌ Strike Symbol ▐ ▌ SysOP Security ▐ ▌ Quote Ratio % ▐ ▌ Upcase Ratio % ▐ ▌ # Of Taglines ▐ █▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█ · Strike Symbol [*] - What character should IceEdit use when striking out text that can be found in the Censor.Cfg file. Asterisk ("*") is the default. · SysOp Security - What is the SysOp security level to activate the dictionary 'word-adding' feature. · Quote Ratio % - Up to what percentage is Quoted text allowed in the message text. · Upcase Ratio % - Up to what percentage is upcase text allowed in the message text. · # Of Taglines - What number of taglines should a user be allowed to pick from when they have chosen to save their message? [1..10] (User makes use of light bar to select tagline) {+} ┌───────────────────────────────────────────────────────────────────────────┐ │░░░▒▒▒▓▓▓ Setting Up IceEdit.Exe With RemoteAccess ▓▓▓▒▒▒░░░│ └───────────────────────────────────────────────────────────────────────────┘ Please read the section of this document entitled 'Program Information - Using EditCfg' BEFORE attempting to install IceEdit into RA. Failure to setup IceEdit correctly before installing it into your bbs program will probably result in IceEdit failing to run or not running as expected. In order to run IceEdit.Exe with a user ONLINE, you must have a fossil driver active. A fossil driver such as BNU should work fine with IceEdit. If you don't have a fossil driver installed, a simple error message will be displayed, and the program will stop. A fossil is NOT required when running locally. **Note** : Do _NOT_ write protect _ANY_ Of the IceEdit files, if you do, IceEdit will ignore them, and therefore not run properly. We will now run through EVERYTHING you need to do in order to get IceEdit to run in your RemoteAccess setup. 1. Extract all the files in the distribution archive to a directory of your choice. C:\RA\ is recommended and is assumed to be the directory you are using from now on. 2. To help IceEdit find it's configuration files (if it is not being run from the current directory), you need to define an environment variable for it in this manner in your AutoExec.Bat : SET IEDIT={PATH TO ICEEDIT DIRECTORY} PLEASE NOTE, THE ENVIRONMENT VARIABLE NAME IS IEDIT - NOT ICEEDIT !! The environment variable is used by IceEdit to find its system files and configuration. Failure to setup the environment variable can result in IceEdit failing to run correctly - YOU HAVE BEEN WARNED! Please see your DOS manual for more information on environment variables. N.B. You will need to reboot your machine after entering the environment variable for it to take effect. 3. Run EditCfg.Exe and configure all of IceEdit's options as explained earlier in this document. You MUST configure IceEdit for it to work correctly! Refer to the section of this document for setting up IceEdit. 4. IceEdit needs to be setup in RACONFIG.EXE so that when the user attempts to write a message it calls up IceEdit and NOT the internal RemoteAccess line-by-line editor. Change to your RemoteAccess directory and run RACONFIG.EXE. Go to OPTIONS>MESSAGES>EXTERNAL EDITOR. Place the command- line to run IceEdit.Exe in this space. Eg. C:\RA\IceEdit.Exe *M If you wish, you can specify the path to the dropfiles read in by IceEdit (Dorinfo1.Def, MsgInf, and MsgTmp if it exists) by adding the following parameter to your commandline like this: ICEEDIT.EXE /D:[PATH TO DROPFILES] Eg: C:\RA\IceEdit.Exe /D:C:\RA Otherwise IceEdit will assume the dropfiles are located in the current directory (usually your BBS directory) If you are PLANNING TO RUN ICEEDIT FROM YOUR NEWUSER.Q-A, then you should use the following commandline in your RaConfig setup. C:\RA\ICEEDIT.EXE /B:*B /P:*P /T:*T *M *B - Passes the baudrate out to the commandline. *P - Passes the modem port out to the commandline. *N - Passes the nodenumber as read from the %TASK% environment variable out to the commandline. *M - Activate the MemorySwap feature. *T - Passes time limit out to the commandline. 5. When you run IceEdit, be sure that the IceEdit.Cfg file has been created. If it has not, then you MUST run EditCfg.Exe. If you don't, and attempt to run IceEdit.Exe directly, IceEdit will display an error message that IceEdit.Cfg doesn't exist. ┌───────────────────────────────────────────────────────────────────────────┐ │░░░▒▒▒▓▓▓ Files That Are Used By IceEdit ▓▓▓▒▒▒░░░│ └───────────────────────────────────────────────────────────────────────────┘ IceEdit will call upon a number of files during runtime. They are listed below along with a brief description. CENSOR.CFG - This is a textfile containing inappropriate words that IceEdit will strike out of the message text when they are encountered. {+} CONFIG.RA - This file is read ONCE only by EDITCFG when you first install IceEdit. It will only be read if EditCfg can find the RA environment variable. It is compatible with the RA 2.0x Config.Ra file only. It will not read the Ra 1.1x format. COL_HELP.ANS - This is an ANSi file that will be displayed that will replace the hardcoded colour help menu. You can create this with an ANSi editor such as TheDraw. DORINFO1.DEF - This is the dropfile that most BBS packages can create that holds important user profile information. ICEEDIT.CFG - This is IceEdit's configuration file. It is absolutely necessary in order for IceEdit.Exe to function. ICEEDIT.DIC - This is the IceEdit dictionary that is used in conjunction with the spellcheck feature. It comes in a separate package from the main IceEdit program, due to its size. ICEEDIT.IDX - This is the IceEdit dictionary index file that comes with the dictionary. It is also located in the secondary package. ICEEDIT.MDX - This file is scanned by IceEdit if you are using RA, and have run EDITCFG.EXE INDEX. This file is an index that contains the current toggle settings for all message areas. Toggle settings include taglines, pipecodes, ANSi filtering, and message censoring. KEY_HELP.ANS - This is an ANSi file that will be displayed that will replace the hardcoded Userkey help menu. You can create this with an ANSi editor such as TheDraw. MACRO.CFG - This is the file that contains the replacement macros that can be used in IceEdit. It is compatible with the MACRO.CFG file that IceChat uses. This file must be edited using EDITCFG.EXE. MSGINF. - This file contains message writing information. MSGTMP. - This file can contain both quoted message text as well as the regular message text that will be read back in by the BBS package. TAGLINES.### - This is a tagline database that IceEdit will use to pick a random tagline to be appended to the end of messages. {+} ┌───────────────────────────────────────────────────────────────────────────┐ │░░░▒▒▒▓▓▓ IceEdit.Exe Commandline Parameters ▓▓▓▒▒▒░░░│ └───────────────────────────────────────────────────────────────────────────┘ Note: ALL Commandline parameters are optional, and do NOT have to be used unless you are trying something new and different with IceEdit =). Generally these parameters are only used with you are trying to run IceEdit without a DORINFO1.DEF file (such as an offline mail reader) /B:[BAUD] - Use this parameter to specify the baudrate. Eg. ICEEDIT.EXE /B:14400 /BW - Use this parameter to tell IceEdit that you are using an offline mail reader, such as BlueWave. If this is the case, your commandline generally will not use any of the other commandline parameters. /D:[PATH] - Use this parameter to specify the path ONLY to the dropfiles that are to be used by IceEdit (DORINFO1.DEF, MSGTMP, MSGINF) Eg. ICEEDIT.EXE /D:C:\RA\LINE2 /F:[FILENAME] - Use this parameter to change the default textfile name that message text will be stored in. (Default = "MSGTMP") This is useful for offline mail readers. Eg. ICEEDIT.EXE /F:MSGTEMP.BBS /FORCE - Use this parameter to make sure that the user can't abort the message they are writing. This is useful for NewUser Questionnaires, where you want to make sure the user actually writes an introductory comment. /K:[TIMEOUT] - Use this parameter to specify in SECONDS how long IceEdit will wait in keyboard inactivity before disconnecting. /L - Use this parameter to run IceEdit in local test mode. Eg. ICEEDIT.EXE /L /N:[NODE] - Use this parameter to specify the NODE that IceEdit is being run on. A MUST FOR MULTINODE SYSTEMS!!!!!! (Default = 1) /P:[COMPORT] - Use this parameter to specify comport to be used by IceEdit. If you port is com3, then this is the commandline: ICEEDIT.EXE /P:3 /T:[MINUTES] - Use this parameter to specify the amount of time remaining for the user. Eg. ICEEDIT.EXE /T:30 Please note: If you change any values above that correspond with values in the DORINFO1.DEF File, then the DORINFO1.DEF value will be overridden. ┌───────────────────────────────────────────────────────────────────────────┐ │░░░▒▒▒▓▓▓ Editing your message in IceEdit ▓▓▓▒▒▒░░░│ └───────────────────────────────────────────────────────────────────────────┘ Function Keys --------------- To make message editing go easier, there are a number of different keys that may be used by both the SysOP and the user. A list follows: UP ARROW - Moves the cursor up one line DOWN ARROW - Moves the cursor down one line LEFT ARROW - Moves the cursor to the left one space RIGHT ARROW - Moves the cursor to the right one space INSERT - Toggle the text insert/typeover mode DELETE - Delete the character currently under the cursor CTRL-A or /A - Abort message text & exit program CTRL-B - Restore line of text from buffer CTRL-C - Center the current line of text on the screen CTRL-D - Move cursor to the right one space CTRL-E - Move cursor up one line CTRL-J - Left justify the current line of text on the screen CTRL-K - Toggle LineDraw mode ON or OFF, or select line style CTRL-L - List / edit available macros CTRL-P - Place cursor at the end of the line CTRL-Q or /Q - Quote window (Available only with message replies) CTRL-R - Redraw the editing screen CTRL-S - Move cursor to the left one space CTRL-T - Delete text from the cursor to the end of the line CTRL-U - Delete text from the cursor to the end of the current word CTRL-V - Toggle INSERT/TYPEOVER Modes CTRL-W - Return cursor to the beginning of the line CTRL-X - Move cursor down one line CTRL-Y - Erase current line of text CTRL-Z or /S - Save message text & exit program There are also SysOP only keys that may be used: F1.. 10 - Activate previously defined SysOp text macros ALT- F2 - Import a textfile into the message ALT- F3 - Export message contents to a file ALT- C - Invoke external chat utility ALT- H - Terminate Connection ALT- J - Shell to DOS ALT- = - Add one minute to user's time ALT- - - Subtract one minute from user's time Imbedded Replacement Strings ------------------------------ All replacement macros, taglines and SysOp function keys can make use of the following built in control strings (NOTE ** Some are repeated to ensure compatibility with ICECHAT replacement strings) : @A = SysOp name (Read From IceEdit Configuration) @B = BBS name (Read From IceEdit Configuration) @D = Date @F = Receiving users first name @R = Receiving users first name @S = SysOp name (Read From IceEdit Configuration) @T = Time of day @U = Sending user's first name @V = Program version number The control strings can be used in the following manner. For Example, if you were configuring one of your macros to tell the current time & Date, you could put: "MTD" -> "This message was written at @T on @D." And then when IceEdit is run, if the user chooses to type in the "MTD" macro, the strings would be replaced and the result would be: "This message was written at 2:41p on 02/19/95." All the control strings can be used in a similar manner in all the other macros & taglines, and Fn keys. Imbedded Colors ----------------- With IceEdit, it is possible to use color codes into your Message text. This is very easily done. Wherever you would like to have a color change in your message, type one of the following codes: |00 - Black |01 - Blue |02 - Green |03 - Cyan |04 - Red |05 - Magenta |06 - Brown |07 - LightGray |08 - DarkGray |09 - LightBlue |10 - LightGreen |11 - LightCyan |12 - LightRed |13 - LightMagenta |14 - Yellow |15 - White So, If you had a line such as: "|15This is a |09test." The first three words "This is a" would be in White, and the rest, "Test." would be in LightBlue once the message has been saved. Please be aware of two important points. Firstly, IceEdit will NOT CHANGE the color WHILE YOU ARE EDITING the message. Color strings will be converted when the message is saved. Second, these codes are replaced with ANSi escape sequences (the same codes that are used in your ANSi screens). Many networks do not authorize ANSi escape codes in their echos. If you are going to make use of this feature, it is recommended that users are informed on the point that they should not use embedded color strings in echomail areas. If you are using RemoteAccess, it is possible to make IceEdit determine whether or not the message area is a local base. If it is NOT, IceEdit can automatically temporarily disable Imbedded colors in the message that the user is writing. Imbedded Files ---------------- With IceEdit, it is possible to have external filenames that will be later imported into into your Message text. This is very easily done. Wherever you would like to have a file imported into your message, use the following method. For Example, say you have a textfile with some type of header in it that you want to import into your message. The filename of the header is BBSHDR.ASC for our example. In your message you would put the following on a blank line of text: %[BBSHDR.ASC]% When your message is saved, IceEdit will seek out the filename between the two special brackets ( %[ and ]% ). You can specify the path of the file aswell, if the file is not located in your current directory, for example: %[C:\BBS\TXTFILES\BBSHDR.ASC]% When the message is saved, IceEdit will find this file, and import it into the body of the message text, so your message might end up looking like this: ▐██▌░▄█████▄ ▄██████░ ███████░▄██████░▄█████▄ ██░ ██░ ██░ ██░░░░░ ██▄▄▄▄░ ▐█▌░░░██▄▄▄▄░ ██░░░░░ ██▄▄▄██░ ██░ ██░ ██▀▀▀▀░ ▐█▌░ ██▀▀▀▀░ ██░ ██▀▀▀██░ ▐██▌░▀█████▀ ▀██████░ ▐█▌░ ▀██████░▀█████▀ ██░░░██░ ██░ ██░░░ ██░██░ ██░ ██░██░░ ██░░░ ██░ █▌░ ▐▌░ ▐▌░ ▐▌░▐▌░ ▐▌░ ▐▌░▐▌░ ▐▌░ ▐▌░ ▐░ ▌░ ▐░ ▌░ ▐░ ▌░ ▐░ ▐░ Please be aware of an important point. IceEdit will NOT IMPORT the file(s) WHILE YOU ARE EDITING the message. File(s) will only be imported when the message is saved. LineDraw Mode --------------- IceEdit has a "linedraw" mode. When the user activates this mode, it is possible to draw High-Bit ASCII lines on the screen by using the Cursor Keys (Left, Right, Up, Down). There are 3 line styles available: 1) ╔═╗ 2) ╒═╕ 3) ┌─┐ And that's all there is to it.. Hope you guys enjoy this thing, and it is my hope that IceEdit becomes the default editor used with your system =-) ┌────────────────────────────────────────────────────────────────────────────┐ │░░░▒▒▒▓▓▓ Other IceSoft Utilities ▓▓▓▒▒▒░░░│ └────────────────────────────────────────────────────────────────────────────┘ Here is a list of all the IceSoft utilities that were available at the time of release of this archive. If you enjoy using this IceSoft utility, you may want to check some of these out! :) · IceChat - IceChat is a split screen chat utility for RemoteAccess BBS packages. It can be used with many other BBS types as long as they support Dorinfo1.Def/Door.Sys type Doors. · IceEdit - IceEdit is a fullscreen ANSi message editor that was originally designed for use with RemoteAccess. Although it has only been tested with RemoteAccess v2.0x, and TeleGard v2.7 it should be compatible with any other BBS that uses the QuickBBS style dropfiles that contain the message writing information. These files are MSGTMP & MSGINF. You should check your BBS documentation to see if your software supports this system. IceEdit also calls on the Dorinfo1.Def file to read in necessary information about the user profile. · IceNote - IceNote is one of the newest IceSoft doors available. It is a message to all users type door with many neat features. It has been tested with both RemoteAccess v2.0x, and the latest release of Renegade, and should work with any other Dorinfo1.Def compatible BBS Packages. · IceBank - IceBank is the very newest IceSoft utility available. It is a fully functional, fully configurable timebank system for RemoteAccess v2.0x. It has many cool features, including InterBBS transactions. ┌───────────────────────────────────────────────────────────────────────────┐ │░░░▒▒▒▓▓▓ Program Support - BBS Locations ▓▓▓▒▒▒░░░│ └───────────────────────────────────────────────────────────────────────────┘ IceEdit can be File Requested from any of the following BBS's under the magic name of ICEEDIT. 1200-14400 Baud Rates Supported. Legend ────── S - Support Site B - Beta Site R - Registration Site D - Distrib. Site BBSName Location Phone FidoNET Flags ────────────────────────────────────────────────────────────────────────── Ice Technologies ON, CAN (905) 895-7775 1:250/912 S B R D 14.4 Concession Stand FL, USA (407) 569-6568 1:374/6568 S B D 28.8 Pacific Coast Micro CA, USA (805) 494-9386 1:102/1001 S D 14.4 Pacific Coast Micro CA, USA (805) 494-8427 1:102/1005 S D 14.4 Infinity Links Australia 61-3-850-9115 3:633/262 S B R D 14.4 The Silverado Germany 49-6221-767992 2:2468/6018 S B R D 19.2 Slash BBS Holland 31-4780-10920 2:512/67 S R D 28.8